home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr10 / e4v160.zip / E4README.TXT < prev    next >
Text File  |  1993-06-04  |  18KB  |  458 lines

  1. ****************************************************************
  2. E4(tm) Editor (C) Copyright N.Faulks 1992. All Rights Reserved.
  3. ****************************************************************
  4.  
  5. Note that this file is an E4 outline document (as well as a
  6. printable text file), to view it in outline form, from within
  7. E4, press ALT-H, then Y for "Yes". Now you can press ALT-H over
  8. headings or text you would like to open or close.
  9.  
  10. INTRODUCTION ***************************************************
  11.  
  12.  E4 is a powerful multi-file text editor with outlining,
  13.  macros, SVGA support, and in-editor compilation and
  14.  error tracking.
  15.  
  16.  E4 isn't a bloated every-feature-under-the-sun product,
  17.  it is a small, fast editor that manages to provide most
  18.  of the features most people use.
  19.  
  20.  E4 is great for people who only want to edit
  21.  AUTOEXEC.BAT and CONFIG.SYS as well as Programmers and
  22.  System/Network Adminstrators. The simple but powerful
  23.  macro facility turns E4 into a complete Program
  24.  Development Environment.
  25.  
  26.  E4 really is better than other editors, because it is
  27.  easy to use and powerful. Yes, you have to take the
  28.  trouble to learn it, but once you have got over the
  29.  short initial learning curve it WILL make you more
  30.  productive. Easy to use doesn't have to mean pull down
  31.  menus and WIMPs. E4 works well with a mouse, but the
  32.  common commands are only a single mnemonic keystroke (E4
  33.  doesn't use the function keys: how can they be easy to
  34.  remember?). It doesn't matter if you have "every
  35.  feature" if they are all equally difficult to use. E4
  36.  makes everyone into an expert: the "Hintline" shows you
  37.  most of the commands or options available, at every
  38.  point in the editor. Full context-sensitive help makes
  39.  E4 easy to learn.
  40.  
  41.  Feature lists are not the whole story: that's why E4 is
  42.  made available on a try-before-you buy basis. Don't just
  43.  reject it because it isn't exactly the same as what
  44.  you're using: try it!
  45.  
  46.  E4 already has a large user community including
  47.  professional programmers, businesspeople, educators, and
  48.  students. If you've got a suggestion, complaint or
  49.  problem call the author (Neil Faulks) on 071 873 2007
  50.  (+44 71 873 2007) during office hours, or mail him on
  51.  the Internet (neil@dcs.kcl.ac.uk) or through CompuServe
  52.  (>INTERNET:neil@dcs.kcl.ac.uk). We want you to be happy
  53.  with E4, before and after you buy it.
  54.  
  55. NOTICE *********************************************************
  56.  
  57.  This is a Try-before-you-buy Evaluation copy of the E4
  58.  Editor, it is fully functional. You may use E4 freely
  59.  for up to 30 days, but if you want to use it after this
  60.  period you must pay for it. See later in this file.
  61.  
  62.  Occasionally the editor will ask you to press a key when
  63.  you first run it, this feature is absent from the
  64.  version you will receive upon payment.
  65.  
  66.  Buying your own copy also brings the benefits of
  67.  comprehensive printed documentation, extra utility
  68.  programs and macros.
  69.  
  70.  Programmers: note that only the registered version
  71.  supports compiler error message tracking, as it requires
  72.  extra support programs.
  73.  
  74. PACKING LIST & RELEASE NOTES ***********************************
  75.  
  76.  This software should be distributed as the single .ZIP
  77.  or .EXE archive. The archive file contains the files
  78.  listed below. PLEASE KEEP THE ORIGINAL ARCHIVE FILE TO
  79.  GIVE TO OTHERS.
  80.  
  81.  E4.EXE         The Editor itself (All you really need!)
  82.  E4.HLP         The help file for the editor
  83.  E4KEYS         A sample keyboard mapping file
  84.  E4README.TXT   This document, Please read it all
  85.  E4FEATS.TXT    A long list of features
  86.  E4ORDER.TXT    Printable order form. Site, Network or
  87.                 Educational versions are available
  88.  E4VENDOR.TXT   Notes for shareware vendors and BBSs.
  89.                 Includes feature lists and descriptions
  90.  FILE_ID.DIZ    A BBS description file
  91.  TEMPLATE.C     A sample template file for C programmers
  92.  E4OPTS.C       A sample options file (for C programs)
  93.  
  94.  The sample E4KEYS file includes some key definitions of
  95.  use only to programmers, to handle in-editor
  96.  compilation. These are distributed as macros in the
  97.  registered version, but are included here in the keys
  98.  file, to save space. The sample definitions allow you to
  99.  compile from within the editor (a single file or a
  100.  complete project), and to execute your program with or
  101.  without a debugger. The registered version provides full
  102.  error tracking, allowing you to step through error
  103.  messages one by one, taking you to the correct file and
  104.  line.
  105.  
  106.  Programmers should examine the E4KEYS file to learn
  107.  about creating macros to compile and debug programmers.
  108.  
  109. CHANGES ********************************************************
  110.  
  111.  Only major changes are listed, numerous minor changes
  112.  are made with every release. Registered version has more
  113.  detailed information.
  114.  
  115.  Version 1.6
  116.         
  117.         Outlining. XMS swapping (leaving <2K resident).
  118.         Colour Brackets. LOOP, ENDLOOP and STOP in
  119.         macros. Support for Read-only buffers
  120.         (independent of Read-only files).
  121.                 
  122.  Version 1.51
  123.         
  124.         New Ditto function using ALT-Space Bar. New
  125.         CATCH macro keyword (useful in template macros).
  126.         Enhanced handling of Read-Only files, can now
  127.         edit System and Hidden files also. Enhanced
  128.         handling of environment variables in DOS
  129.         commands. Better handling of ^Break when macro
  130.         playing is paused. Modified screen blanker to
  131.         allow portables to power down.
  132.         
  133.  Version 1.5
  134.         
  135.         Support for external commands and tools. All new
  136.         Picture mode/Line Draw mode. Automatic Project
  137.         File creation. New commands: Buffer Reload,
  138.         Tools Editclip, Goto Edit (New edit tracking
  139.         system). Multiple tags. New Wordprocessing and
  140.         WordWrap modes. Support for bright screen
  141.         background colours. More support for Novell
  142.         Netware. Template Macros. Enhanced Find Eol to
  143.         allow searching for Lone CR or LF at ends of
  144.         lines. Extended help system.
  145.         
  146.  Version 1.0
  147.         
  148.         First non-commercial release.
  149.  
  150. OVERVIEW *******************************************************
  151.  
  152.  E4 will run on any PC compatible with 128K of RAM, under
  153.  MSDOS 3.0 or above, and any standard display adaptor. A
  154.  hard disk is not required: the minimum installation is
  155.  less than 40K.
  156.  
  157.  SVGA support allows for special text modes such as
  158.  100x40, 132x60, on those cards that offer it.
  159.  
  160.  Full use is made of enhanced keyboards including F11 &
  161.  F12 and other special key combinations. Full mouse
  162.  support (for a Microsoft compatible mouse) allows on
  163.  screen selection of text and menu operation. Note that
  164.  mouse support in SVGA screen modes often does not work
  165.  due to mouse driver limitations.
  166.  
  167.  The editor occupies less that 40K of disk space making
  168.  it suitable for installation on a RAM Disk, the optional
  169.  help file can be relocated elsewhere; using the E4HELP
  170.  environment variable.
  171.  
  172.  E4 has a short start up time and loads and saves files
  173.  very quickly.
  174.  
  175.  Most of the keys on the keyboard may be redefined to
  176.  suit you. Any standard key combination may be assigned
  177.  to any editor function, simply by editing a text file
  178.  listing the assignments to be made (E4KEYS). A command
  179.  line switch can be used to override customisation so
  180.  that someone can use the editor on another person's
  181.  machine, for example when giving help in a school or
  182.  college.
  183.  
  184.  The normal Cut and Paste system, which allows arbitrary
  185.  streams of characters to be moved about the editor, is
  186.  augmented by a simple system for moving and copying
  187.  whole lines, as this is such a common operation.
  188.  
  189.  A design limitation is that the maximum file size that
  190.  may be edited is 64K, and is one reason the editor is so
  191.  small. This limit is offset somewhat by the ease with
  192.  which multiple files may be edited. In particular you
  193.  are able to perform a truly global search and replace
  194.  operation that affects several files. When programming
  195.  it is not a good idea to construct a program by using
  196.  one monolithic file, better to split it up into several
  197.  modules.
  198.  
  199.  E4 comes with complete context-sensitive on-line help.
  200.  But you can use page-up and page-down to move through
  201.  the help screens if you want to make sure you see it
  202.  all. Press F1 twice to find out how to use help.
  203.  
  204. INSTALLATION & RUNNING *****************************************
  205.  
  206.  DOS 3.0 or above is needed to run E4.
  207.  
  208.  Copy the files listed in the packing list above to a
  209.  directory on your hard disk and put that directory on
  210.  your PATH. For example if you create a directory for the
  211.  editor called C:\E4 then you should add the following
  212.  line to your AUTOEXEC.BAT file:
  213.  
  214.         PATH C:\E4;%PATH%
  215.  
  216.  If you have DOSKEY, CED, ANARKEY or a similar command
  217.  line editor, you can have an alias that expands to the
  218.  full pathname of the editor, instead of adding the
  219.  editor directory to the PATH. E4 does not need to be in
  220.  the path to find its support files.
  221.  
  222.  Run the editor with the list of filenames you wish to
  223.  edit. Wildcards may be included:
  224.  
  225.         E4 \AUTOEXEC.BAT \CONFIG.SYS \WINDOWS\*.INI
  226.  
  227.  NOTE: A few systems may not correctly identify the type
  228.  of keyboard they have: if the editor hangs then reboot,
  229.  and run it again with the /P switch, which forces it to
  230.  use only the standard (PC) keyboard driver, rather than
  231.  the enhanced (AT) driver. Note that the editor has been
  232.  tested and does work correctly on true IBM PCs, IBM
  233.  PC/ATs and IBM PS/2s, as well as many machines from a
  234.  variety of manufacturers including Compaq, Dell, Grid,
  235.  NEC and Tandon.
  236.  
  237.  The /B command line switch will run the editor in black
  238.  and white. /? will list other switches.
  239.  
  240.  F1 displays context sensitive help.
  241.  
  242.  Press ALT-Q to leave the editor.
  243.  
  244.  You can put standard switch settings into the E4
  245.  environment variable:
  246.  
  247.         SET E4=/B
  248.  
  249.  The example above will cause the editor to always run in
  250.  Black and White.
  251.  
  252.  Configuration files and macro directories are created by
  253.  default in the current directory. To make the editor
  254.  place them in the directory containing E4.EXE use the
  255.  following command:
  256.  
  257.         SET E4PATH=*
  258.  
  259.  These SET statements are best placed in your
  260.  AUTOEXEC.BAT file.
  261.  
  262. DEMO ***********************************************************
  263.  
  264.  For a short demonstration of Resume Mode go to the root
  265.  directory of your boot disk and (assuming E4 is in your
  266.  PATH) type
  267.  
  268.         E4 /R AUTOEXEC.BAT CONFIG.SYS
  269.  
  270.  Then press ALT-Q to quit the editor.
  271.  
  272.  Now whenever you want to edit your configuration simply
  273.  go to the root directory and type
  274.  
  275.         E4
  276.  
  277.  The cursor will be where it was and the same files will
  278.  be loaded. Any new files you load will also be available
  279.  to future sessions.
  280.  
  281. EXAMPLE APPLICATION NOTE ***************************************
  282.  
  283.  If you use Borland's Paradox (3.5 or 4.0) you can
  284.  install E4 as the default editor. Use the following
  285.  command line:
  286.         
  287.         E4 /XSC * /**
  288.  
  289.  This sets the default extension for loading and saving
  290.  to .SC (for script). Paradox replaces the * by the
  291.  filename and the ** by a line number within the file (E4
  292.  interprets a number after a slash as a line number to go
  293.  to on start up).
  294.  
  295. SUPPORT ********************************************************
  296.  
  297.  Technical support is available directly from the author
  298.  by Post or E-Mail to any of the addresses given at the
  299.  foot of this document. E-mail is preferred.
  300.  
  301.  Support is available whether or not you are a registered
  302.  user: We want you to be happy with E4 before you buy it.
  303.  
  304. ORDERING and PAYMENT *******************************************
  305.  
  306.  This software has been made available so that potential
  307.  users may try it out before committing to buy it. If you
  308.  think that you have already paid for this software then
  309.  you have been mislead by whoever took your money. Many
  310.  organisations charge a copying fee for providing
  311.  evaluation copies of software like this, which is
  312.  legitimate within the limits detailed in the
  313.  E4VENDOR.TXT file. Others, who may also be charging a
  314.  higher fee, do not make it clear that you are paying
  315.  them a service charge for providing you with an
  316.  evaluation copy of the software.
  317.  
  318.  You must pay for this software if you continue to use
  319.  it. This is copyrighted commercial software. The term
  320.  "Shareware" is often applied to software marketed in
  321.  this way, but it must not be confused with free software
  322.  such as that in the Public Domain (PD).
  323.  
  324.  To pay for this software please examine the file
  325.  E4ORDER.TXT, which is a registration and order form. You
  326.  can fill this in before or after printing it out.
  327.  Alternatively any form of order may be used provided
  328.  that all the information requested in the text file is
  329.  provided. Always quote the issue number given on that
  330.  form (the same Issue Number appears in the editor banner
  331.  screen).
  332.  
  333.  In exchange for payment you will receive a version of
  334.  the software without the registration reminders, and
  335.  which is registered to you personally. The price
  336.  includes a comprehensive printed manual and extra
  337.  utility programs and macros.
  338.  
  339.  Note that this registered version may not be distributed
  340.  in any way and must be treated like any other commercial
  341.  program. Please refer to the licence agreements below.
  342.  
  343. EXTRAS *********************************************************
  344.  
  345.  The following programs (at least) are shipped with the
  346.  commercial version of the editor:
  347.  
  348.  E4SM   a program to set special text modes on VGA/EGA
  349.         cards. It also analyses your VGA card to find
  350.         out what special text modes are available.
  351.  
  352.  E4TRAP a program to trap error output from a range of
  353.         compilers so that E4 can perform error tracking.
  354.         Currently supported compilers include Borland
  355.         C/C++, Turbo Pascal, Turbo Linker, Turbo
  356.         Assembler, Microsoft C, MASM, Fitted Software
  357.         Modula-2, Zortech C/C++ and others. Other
  358.         compilers will be added in the future.
  359.         
  360.         Many compilers that are not listed will also
  361.         work, if they generate standard error messages.
  362.         Contact us if your compiler is not listed, we
  363.         will add it if necessary.
  364.  
  365.  E4PRINT        a program to print E4 wordwrap files (and
  366.         ordinary text files) on normal and PostScript
  367.         printers.
  368.  
  369.  A library of useful programmer's macros is also
  370.  provided.
  371.  
  372. LICENCE AGREEMENTS *********************************************
  373.  
  374.  "The software" refers in this case to the E4 editor and
  375.  any associated documentation and/or additional programs
  376.  or other items.
  377.  
  378.  "The purchaser" is that person or organisation that pays
  379.  the fee for the software.
  380.  
  381. Licence for the Unregistered Version (this version) ************
  382.  
  383.  This software is copyrighted and any duplication other
  384.  than under the terms of this agreement is a breach of
  385.  copyright law. You are given permission to duplicate the
  386.  software to give to others provided that you do not make
  387.  any changes to the software and that you distribute it
  388.  complete (preferably as the single self-extracting
  389.  archive file described above). You must not make a
  390.  charge for providing a copy of the software other than
  391.  within the limits detailed in the E4VENDOR.TXT file.
  392.  
  393.  You are permitted to use the editor for a period not
  394.  exceeding 30 days beginning from the date of first use.
  395.  After this time you must pay if you wish to continue
  396.  using it, even if you intend to do so only infrequently.
  397.  If you do not purchase your own copy then you should
  398.  keep the software only in its archived (unusable) form
  399.  for the purposes of giving it to others.
  400.  
  401.  Licences for the Commercial Version (sent to you upon
  402.  ********** registration and payment)
  403.  
  404.  This software is copyrighted and any duplication other
  405.  than under the terms of this agreement is a breach of
  406.  copyright law.
  407.  
  408.  Payment of the registration fee gains for the purchaser
  409.  one or more disks and a licence to use the software
  410.  contained on those disks subject to the conditions
  411.  detailed below.
  412.  
  413. Single user Licence ********************************************
  414.  
  415.  The software provided upon payment of the registration
  416.  fee may not be duplicated other than for the purposes of
  417.  installing it on one or more computers owned by the
  418.  purchaser of the software, and/or for a single "back-up"
  419.  copy of the supplied original disk or disks. The
  420.  purchaser may install the software on more than one
  421.  computer provided that there is no possibility that more
  422.  than a single copy of the software be in use at any
  423.  instant.
  424.  
  425. Network Licence ************************************************
  426.  
  427.  Purchase of a network licence allows you to install the
  428.  software on a single file server only (NOT a node in a
  429.  peer-to-peer network). The software may be used only by
  430.  machines attached to that network that are using that
  431.  server. The software may not be installed on any other
  432.  computer.
  433.  
  434.  You must take all reasonable precautions to prevent
  435.  unauthorised copying. For example, for a Novell network
  436.  you must set the Execute Only attribute for all
  437.  executables that form part of the software.
  438.  
  439. AFTERWORD and ADDRESSES ****************************************
  440.  
  441.  Thank you for taking the time to wade through this file.
  442.  Please try out the program and send me your comments,
  443.  even if you choose not to continue using E4!
  444.  
  445.  Author:                        UK Distributors:
  446.  Neil Faulks            Business Consultants Ltd.
  447.  28 Clickett Hill       37 York Road
  448.  Basildon               Woking
  449.  Essex                  Surrey
  450.  England                        England
  451.  SS14 1NW               GU22 7XN
  452.  
  453.  E-mail:                neil@dcs.kcl.ac.uk
  454.  CompuServe:    >INTERNET:neil@dcs.kcl.ac.uk
  455.  
  456.  
  457. End-of-File
  458.